docs: register stake to Babylon chain #105
Conversation
docs/transition-phase-2.md
Outdated
| ### Babylon Configuration | ||
| ```toml | ||
| [babylon] | ||
| Key = "btc-staker" # Your Babylon key name |
There was a problem hiding this comment.
Do we need to instruct user how to create this key?
There was a problem hiding this comment.
It looks like the instructions can be found here: https://github.com/babylonlabs-io/btc-staker/blob/6d25cf181be58531fff2ed32d2b0625887b9ff6a/README.md#create-a-babylon-keyring-keyring-backend-test-with-funds. Can we somehow tell users that they need to use the key created in this step?
There was a problem hiding this comment.
https://github.com/babylonlabs-io/btc-staker?tab=readme-ov-file#3-btc-staker-installation - we link to this at the beginning, which specifies the account within the guide. Maybe I should mention the babylon account in the prerequisites as its seemingly not clear enough
There was a problem hiding this comment.
In general lgtm. Some high-level comments:
- We should be consistent with babylonlabs-io/babylon@f1ae78e where we use registration other than transition. So we need to change the tone a bit.
- We should stick with
Phase-1orPhase-2other thanphase-1orphase-2
vitsalis
changed the title
|
|
||
| > **⚡ Note**: While these parameters can be provided manually, the global | ||
| > parameters file provides an easier user experience. This guide is only for | ||
| > valid, confirmed Bitcoin staking transactions with valid `OP_RETURN` data. If |
There was a problem hiding this comment.
| > valid, confirmed Bitcoin staking transactions with valid `OP_RETURN` data. If | |
| > valid Bitcoin staking transactions with well-formed `OP_RETURN` data that have received | |
| > sufficient Bitcoin confirmations (e.g., 10 for testnet). If |
|
|
||
| Parameters: | ||
| - `global-parameters-file`: The path to the global parameters file. | ||
| - `your-phase1-tx-hash`: The original hash of your Bitcoin staking transaction. |
There was a problem hiding this comment.
| - `your-phase1-tx-hash`: The original hash of your Bitcoin staking transaction. | |
| - `your-phase1-tx-hash`: The original hash of your Bitcoin staking transaction. | |
| This will be used to retrieve the staking transaction from your wallet. |
| Parameters: | ||
| - `global-parameters-file`: The path to the global parameters file. | ||
| - `your-phase1-tx-hash`: The original hash of your Bitcoin staking transaction. | ||
| - `your-btc-address`: BTC address of the staker in hex. |
There was a problem hiding this comment.
hex? This is weird. Shouldn't it be the normal address?
There was a problem hiding this comment.
--staker-address [btcStakerAddrHex] this is what is required in the cli
| registration by checking your balance on the [Babylon Explorer](https://babylon-testnet.l2scan.co) | ||
| by searching for the `<babylon_btc_delegation_tx_hash>` value. | ||
|
|
||
| This will then give you details on your transaction, which includes the state |
There was a problem hiding this comment.
The below states relate to the statuses maintained by stakerd. Above you refer to going to the Babylon explorer. Something is missing here I think. In general, I recommend that we check the status of the transaction by stakerd/stakercli commands instead of sending people to a 3rd party explorer.
There was a problem hiding this comment.
So ive spoken to rafael, currently the btc staker only has the status of the delegation. The only way is that user needs to look for the tx in the babylond node and if the tx was success in the node then the btc delegation is verfied. This is why I added that we should use the explorer because we dont yet have a native way. But we will be making a query for it.
No description provided.